home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / remote / ratp22.zip / RATOP.DOC < prev    next >
Text File  |  1991-10-30  |  10KB  |  307 lines
  1.  
  2. ------------------------------------------------------------------------------
  3.                                RaTop v2.2
  4.  
  5.                 RemoteAccess Top Users Bulletin Generator
  6.  
  7.                  Copyright (C) 1990-91  Foxtrot Software
  8.                            All Rights Reserved.
  9.  
  10.   This is a shareware program, this program is not to be sold or modified
  11. in any way.  You are free to copy and distribute RaTop as long as:
  12.  
  13.   a.  No fee is charged for use of the program or the documentation.
  14.       A fee may be charged for copying or distibution of this software
  15.       and documentation for others not to exceed US $10.00.
  16.  
  17.   b.  It is not modified in any way.
  18.  
  19.   c.  This software and documentation or either is not used commercially.
  20.  
  21.   d.  You distribute this software along with all documentation and
  22.       registration forms unmodified.
  23.  
  24.   The Author hereby disclaims all warranties relating to this software,
  25. whether expressed or implied, including without limitation any implied
  26. warranties of merchantability or fitness for a particular purpose.  The
  27. author will not be liable for any special, incidental, consequenctial,
  28. indirect or simular damages due to loss of data or any other reason.  The
  29. user of this software bears all risk as to the quality  and performance
  30. of this software.
  31.  
  32. -------------------Now that we have that out of the way-----------------------
  33.  
  34.   If you have any comments or suggestions for improvement of this software,
  35. you can contact me at Info-Center BBS, data: (914)567-1814, 24 hours a
  36. day or leave Net-Mail @Fidonet 1:272/26, @Magnet 100:900/39.
  37.  
  38.   If you like this software, and decide to keep it on your system, then
  39. please register your copy.  Registration is US $8.00.  Please help support
  40. the shareware concept and development of even more quality utilities.
  41.  
  42. Thank you for your support.
  43.  
  44. ------------------------------------------------------------------------------
  45.  
  46. 1. Introduction.
  47.  
  48.    RaTop is a utility that will allow the Sysop of a RA BBS system to
  49. produce a TOP Users Bulletin that conatins the TOP Callers, TOP
  50. Downloaders and TOP Uploaders by name and how many times they called,
  51. bytes downloaded and bytes Uploaded on your system.  
  52.  
  53.   RaTop uses the environment variable RA= to find your USERS.BBS and
  54. CONFIG.RA files.  If the environment variable is not set on your system,
  55. then RaTop must be run in the same directory where these files are
  56. located.
  57.  
  58.   You can set the variable by using the DOS Command SET RA=C:\RA in your
  59. autoexec.bat startup file.
  60.  
  61.   The bulletin is usually placed in same directory as all other text files
  62. so a menu option can be built to allow a user to view the Bulletin.
  63.  
  64.    This version of RaTop is for use with Remote Access V 1.0 and later
  65.    releases.
  66.  
  67.  
  68.  
  69. 2.  Setup.
  70.  
  71.     The following outlines what commands to in the RaTop.CTL control
  72.     file and COLORS available to adjust to your liking.
  73.  
  74.     a.  An Editor that will create text files, such as EDLIN, GALAXY,
  75.         or any Editor that will allow CR/LF combinations at the end of each
  76.         line has to be used.  Create the RaTop.CTL file in your RA BBS
  77.         directory where your Users.BBS file or if the RA environment
  78.         variable is set, the directory you will be running RaTop from.
  79.         Enter the following information:
  80.  
  81. ;
  82. ; Path - Full pathname of where you want the bulletin put.  No extension
  83. ;        is placed on this pathname.  If this command isn't present, then
  84. ;        RaTop will assume BULLET01 only as the filename and place the
  85. ;        bulletins in your current directory.
  86. ;
  87. Path        D:\RA\Txtfiles\Bullet01
  88. ;
  89. ; Title - The Title you wish to have at the heading of the bulletin.
  90. ;         This can be anything you desire as long as it is 70 characters
  91. ;         or less.  If this command isn't present, then RaTop will assume:
  92. ;         'Noname BBS from Anytown, USA'
  93. ;
  94. Title       Info-Center BBS * Top BBS Users Report
  95. ;
  96. ; Frame - This is the color you want the frame of the bulletin to be.
  97. ;
  98. Frame       3
  99. ;
  100. ; Title1 - This is the color you want the Title above to be.
  101. ;
  102. Title1      15
  103. ;
  104. ; Title2 - This is the color you want the Bulletin Heading to be.
  105. ;          The bulletin heading is:
  106. ;          'C A L L E R S   D O W N L O A D E R S   U L O A D E R S'
  107. ;
  108. Title2      10
  109. ;
  110. ; Users  - This is the color you want the users names to be.
  111. ;
  112. Users       14
  113. ;
  114. ; Group -  Include this Keyword only if you want certain user groups to
  115. ;          included in the bulletin.  Valid Group numbers are 0-255.
  116. ;
  117. Group 0
  118. ;
  119. ; Background - This is the color you want the bulletin background to be.
  120. ;
  121. Background  0
  122. ;
  123. ; Security - The lowest security level a user has to have before being included 
  124. ;            in the bulletin.  Max is 64000.
  125. ;
  126. SecurityLvl 5
  127. ;
  128. ; SecFlags - This works exactly like the flags work for RemoteAccess.
  129. ;            
  130. SecFlags    -------- -------- -------- --------
  131. ;
  132.  
  133.  
  134.     b.   Available Colors Codes:
  135.  
  136.                ________
  137.        0  Black         \
  138.        1  Blue           \
  139.        2  Green           \  BackGround or
  140.        3  Cyan             ---------------
  141.        4  Red             /  ForeGround
  142.        5  Magenta        /
  143.        6  Brown         /
  144.        7  LightGray ___/
  145.                 _______
  146.        8  Gray         \
  147.        9  LightBlue     \
  148.        10 LightGreen     \  Foreground Only
  149.        11 LightCyan       ------------------
  150.        12 LightRed       /
  151.        13 LightMagenta  /
  152.        14 Yellow       /
  153.        15 White ______/
  154.  
  155.  
  156.  
  157.     c.  How to run RaTop:
  158.  
  159.         Usage:  RaTop [-?] [-S] [{-U n}] [-?] [{-F CtlFile}]
  160.  
  161.         RaTop can be executed with any or none of the following arguments:
  162.  
  163.         [-S]         -  will tell RaTop to include the SysOp's name and
  164.                         number of Calls, Downloads and Uploads.  Default is not
  165.                         to include the SysOp in the Bulletin.
  166.  
  167.         [-U n]       -  will tell RaTop how many Users you wish to include
  168.                         in the Bulletin.  Default is The Top 20 Users.
  169.                         Valid numbers are from 10 - 64000.
  170.  
  171.         [-?]         -  will tell RaTop to display command line help.  If
  172.                         this argument is to be used, then it must be the only
  173.                         one used on the command line to recieve help.
  174.  
  175.     *   [-F CtlFile] -  will tell RaTop to use an alternate Control file
  176.                         to process.  This would allow you to create numerous
  177.                         bulletins using different security/flags settings.
  178.                         *  Available to Registered Copies Only.
  179.  
  180.  
  181.     d.  All that is needed now is, you to make sure that you have
  182.         RaTop.Exe and RaTop.CTL in the same directory and then execute
  183.         it in that directory.  RaTop.EXE defaults to USERS.BBS and is
  184.         not configurable by you.
  185.  
  186.  
  187. 4.  Closing.
  188.  
  189.     I hope this little utility will help enhance your RA BBS as it
  190.     has mine.  I had fun writing it anyway.
  191.  
  192.  
  193. Update History:
  194.  
  195.     10/10/90      -  First Release 1.0.
  196.  
  197.     10/13/90  Bug -  This one is weird.  But I found that when processing
  198.     v1.1             the index files after they are created to produce the
  199.                      bulletins, if a seek was done to the last record of
  200.                      users file, an eof condition was true, thus prematurely
  201.                      terminating the reads on the index file.  This resulted
  202.                      in an imcomplete report of callers, downloaders or
  203.                      uploaders.
  204.  
  205.               Fix -  Took the Eof check out since direct seeks were being
  206.                      done anyway.
  207.  
  208.  
  209.      09/24/91     -  I did a complete rewrite from Pascal to Turbo-C.  What 
  210.      v2.0            a difference.  Anyway, a slow sort was abolished.  It
  211.                      now sorts as fast as you can blink an eye.  
  212.                      Allows up to the max users RA can handle (65535 I
  213.                      believe).
  214.  
  215.                      Security Level and Security Flag support was added.
  216.  
  217.                      A new feature was added to allow processing of an
  218.                      alternate control file.  This is handy for making
  219.                      multiple bulletins using different securities and
  220.                      flags.
  221.     
  222.      10/27/91      - Added Group checking.  This allows a bulletin to be
  223.      v2.1            created using only certain user groups.
  224.  
  225.                    - Fixed a little bug.  If the Path keyword was ommitted,
  226.                      default BULLET01 file was not being created.
  227.  
  228.      10/27/91      - Using the RA environment variable to find the USERS.BBS
  229.                      created problems for some systems.  Made a small code
  230.                      change to look for USERS.BBS in the current directory.
  231.     
  232.       10/30/91     - Key checking wasn't intrepting the user's key correctly.
  233.  
  234.                      
  235. Other quality software available from me for SysOps:
  236.  
  237. Magic Name     Description
  238.  
  239. RAFBSTAT       Creates a bulletin with stats on all your files areas for
  240.                Remote Access v 1.0.
  241.  
  242. QUIKTOP        Creates a Top Users bulletin for QuickBBS 2.64.
  243.  
  244. OPUSTOP        Creates a Top Users bulletin for OPUS CBCS 1.1x.
  245.  
  246. RATOP          Creates a Top Users bulletin for RemoteAccess 1.01.
  247.  
  248.  
  249.  
  250. PROBLEMS:
  251.  
  252.    Please notify me immediately if you have any problems or
  253. suggestions about this program.  Enhancements are being incorporated
  254. all the time and your input is more vital to this process than you
  255. think.  You may write me, send Net-Mail or logon at the following address:
  256.  
  257. Byron Copeland (Sysop)               Info-Center BBS (formerly The
  258. 11 Y Street                              Foxtrot BBS, 1:360/11)
  259. New Windsor, NY 12553                (914) 567-1814 @Fidonet 1:272/26
  260.                                      24 hours, Every day!
  261.  
  262.  
  263.  
  264.                 Enjoy and thank you for your support.
  265.  
  266.  
  267.                               - End -
  268.  
  269.  
  270.  
  271.  
  272.  
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306. 
  307.